Skip to content

Conversation

clatapie
Copy link
Contributor

@clatapie clatapie commented Aug 6, 2025

Description

This PR follows the PyConverter-XML2Py integration plan to automate the PyMAPDL_commands documentation.
The changes have been generated using pyconverter-xml2py and more specifically mapdl-cmd-conv.

This PR focus on the first part of the solu submodule integration.

You can check the mapdl-cmd-conv documentation to have a look at the output of each methods.

Pinging @ansys/pymapdl-developers for visibility. Feel free to provide any feedback on the way the docstrings and the source code generation are handled.

Issue linked

This PR is meant to be merged within the feat/main_solu branch. The latter will gather all the parts of the submodule prior to be merged to the main branch.

Checklist

@clatapie clatapie self-assigned this Aug 6, 2025
@github-actions github-actions bot added documentation Documentation related (improving, adding, etc) new feature Request or proposal for a new feature labels Aug 6, 2025
@github-actions github-actions bot added dependencies maintenance General maintenance of the repo (libraries, cicd, etc) labels Aug 7, 2025
@clatapie clatapie marked this pull request as ready for review August 8, 2025 15:02
@clatapie clatapie requested a review from a team as a code owner August 8, 2025 15:02
@clatapie clatapie requested review from germa89 and pyansys-ci-bot and removed request for a team August 8, 2025 15:02
@github-actions github-actions bot removed dependencies maintenance General maintenance of the repo (libraries, cicd, etc) labels Aug 8, 2025
@ansys-cla-bot
Copy link

ansys-cla-bot bot commented Aug 29, 2025

All Contributor License Agreement (CLA) signatures have been captured successfully. Thanks for contributing!

@github-actions github-actions bot added CI/CD Related with CICD, Github Actions, etc examples Publishing PyMAPDL examples dependencies maintenance General maintenance of the repo (libraries, cicd, etc) labels Aug 29, 2025
Copy link

codecov bot commented Aug 29, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
⚠️ Please upload report for BASE (feat/main_solu@651042d). Learn more about missing BASE report.

Additional details and impacted files
@@                Coverage Diff                @@
##             feat/main_solu    #4154   +/-   ##
=================================================
  Coverage                  ?   91.28%           
=================================================
  Files                     ?      198           
  Lines                     ?    15781           
  Branches                  ?        0           
=================================================
  Hits                      ?    14406           
  Misses                    ?     1375           
  Partials                  ?        0           
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@github-actions github-actions bot removed CI/CD Related with CICD, Github Actions, etc examples Publishing PyMAPDL examples dependencies labels Sep 8, 2025
@github-actions github-actions bot removed the maintenance General maintenance of the repo (libraries, cicd, etc) label Sep 8, 2025
@clatapie
Copy link
Contributor Author

clatapie commented Sep 8, 2025

This PR is ready for review @germa89

Copy link
Collaborator

@germa89 germa89 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. Few minor comments.

The order of specifying the gap nodes is important; that is, a gap condition connecting two nodes
will act differently depending upon which node is specified first on the :ref:`gp` command. For
example, for Node 1 at ``X`` = 0.0, Node 2 at _nolinebreak ? ``X`` =
0.1 /_nolinebreak ?, and the gap defined from Node 1 to 2, a displacement of Node 1 greater than
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

_nolinebreak ? I never saw that. Please, confirm this is correct.

Comment on lines +153 to +155
.. warning::

This command is archived in the latest version of the software.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This on me, but not sure if we should do something with archived commands....

Comment on lines +405 to +409
val1 : str
The description of the argument is missing in the Python function. Please, refer to the `command
documentation
<https://ansyshelp.ansys.com/Views/Secured/corp/v232/en//ans_cmd/Hlp_C_AMSTEP.html>`_ for
further information.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this expected?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Documentation related (improving, adding, etc) new feature Request or proposal for a new feature
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants